Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release web 2023 01 01 #26545

Merged
merged 14 commits into from
Nov 10, 2023
Merged

Release web 2023 01 01 #26545

merged 14 commits into from
Nov 10, 2023

Conversation

naveedaz
Copy link
Contributor

@naveedaz naveedaz commented Nov 2, 2023

ARM (Control Plane) API Specification Update Pull Request

PR review workflow diagram

Please understand this diagram before proceeding. It explains how to get your PR approved & merged.

diagram

[1] ARM review queue (for merge queues, see [4])
The PRs are processed by time opened, ascending. Your PR may show up on 2nd or later page.
If you addressed Step 1 from the diagram and your PR is not showing up in the queue, ensure the label ARMChangesRequested
is removed from your PR. This should cause the label WaitForARMFeedback to be added.
[2] https://aka.ms/azsdk/support/specreview-channel
[3] List of SDK breaking changes approvers in pinned Teams announcement
[4] public repo merge queue, private repo merge queue (for ARM review queue, [1])

If you need further help with anything, see Getting help section below.

Purpose of this PR

What's the purpose of this PR? Check all that apply. This is mandatory!

  • New API version. (Such PR should have been generated with OpenAPI Hub).
  • Update existing version for a new feature. (This is applicable only when you are revising a private preview API version.)
  • Update existing version to fix swagger quality issues in S360.
  • Other, please clarify:
    • edit this with your clarification

Due diligence checklist

To merge this PR, you must go through the following checklist and confirm you understood
and followed the instructions by checking all the boxes:

Breaking changes review (Step 1)

  • If the automation determines you have breaking changes, i.e. Step 1 from the diagram applies to you,
    you must follow the breaking changes process.
    IMPORTANT This applies even if:
    • The tool fails while it shouldn't, e.g. due to runtime exception, or incorrect detection of breaking changes.
    • You believe there is no need for you to request breaking change approval, for any reason.
      Such claims must be reviewed, and the process is the same.

ARM API changes review (Step 2)

  • If this PR is in purview of ARM review then automation will add the ARMReview label.
  • If you want to force ARM review, add the label yourself.
  • Proceed according to the diagram at the top of this comment.

Viewing API changes

For convenient view of the API changes made by this PR, refer to the URLs provided in the table
in the Generated ApiView comment added to this PR. You can use ApiView to show API versions diff.

Suppressing failures

If one or multiple validation error/warning suppression(s) is detected in your PR, please follow the
Swagger-Suppression-Process
to get approval.

Getting help

naveedaz and others added 13 commits March 8, 2023 09:43
* Add new api-version 2023-01-01

* Change default package api-version
* Fix OneDeploy request and response bodies

* Fixing typo
* Add minTlsCipherSuite property

* Move to SiteConfig

---------

Co-authored-by: Chris Rosenblatt <[email protected]>
* Dapr configuration for a site

* removed dapr older definition

* adding back old dapr definition

* Modified 'Dapr' to 'DaprConfig' to resolve conflicts with older dapr definition

* to initiate checks as re-run

* fixed prettier check fail

---------

Co-authored-by: Sushmitha Vangala <[email protected]>
* Dapr configuration for a site

* removed dapr older definition

* adding back old dapr definition

* Modified 'Dapr' to 'DaprConfig' to resolve conflicts with older dapr definition

* to initiate checks as re-run

* fixed prettier check fail

* JS Sdk check fail fix

---------

Co-authored-by: Sushmitha Vangala <[email protected]>
* Adding locations/usages endpoint and example

* Revert "Adding locations/usages endpoint and example"

This reverts commit 4a11107.

* Adding back usages changes with up to date branch

* Updates based on verification tools

* Fixing spacing, adding missing comma

* ran prettier-fix for formatting

* Update for new QMS requirements with ZR

* Using prettier to fix linter error

* Adding ZR endpoint

* Fixing duplicate operationId

* QMS Usages

* Validation changes

* Updating schema

* Updating for collection

* fixing pr comments

* Resolving comments

* Updating description

* Resolving comments

---------

Co-authored-by: Rohini Sharma <[email protected]>
* Adding locations/usages endpoint and example

* Revert "Adding locations/usages endpoint and example"

This reverts commit 4a11107.

* Adding back usages changes with up to date branch

* Updates based on verification tools

* Fixing spacing, adding missing comma

* ran prettier-fix for formatting

* Update for new QMS requirements with ZR

* Using prettier to fix linter error

* Adding ZR endpoint

* Fixing duplicate operationId

* QMS Usages

* Validation changes

* Updating schema

* Updating for collection

* fixing pr comments

* Resolving comments

* Updating description

* Resolving comments

* Removing quota type parameter

---------

Co-authored-by: Rohini Sharma <[email protected]>
* Adding workload profile & resource config to Site

* prettier fix

* cosmetic fix

* updating examples

* prettier fix
* Rename log level enum for dapr

* Fix Python SDK failure for Dapr log level config
* Rename log level num for dapr

* Rename log level num for dapr
* initial change to add ase regions

* addressing comments

* nit adding example as suggested

* formatting code

* add custom word

* prettier everything

* prettier everything
Copy link

openapi-pipeline-app bot commented Nov 2, 2023

Next Steps to Merge

✔️ All automated merging requirements have been met! Refer to step 4 in the PR workflow diagram (even if your PR is for data plane, not ARM).

Copy link

openapi-pipeline-app bot commented Nov 2, 2023

Swagger Validation Report

️️✔️BreakingChange succeeded [Detail] [Expand]
There are no breaking changes.
️️✔️Breaking Change(Cross-Version) succeeded [Detail] [Expand]
There are no breaking changes.
compared swaggers (via Oad v0.10.4)] new version base version
AppServiceCertificateOrders.json 2023-01-01(5ef0718) 2022-09-01(main)
CertificateOrdersDiagnostics.json 2023-01-01(5ef0718) 2022-09-01(main)
CertificateRegistrationProvider.json 2023-01-01(5ef0718) 2022-09-01(main)
DomainRegistrationProvider.json 2023-01-01(5ef0718) 2022-09-01(main)
Domains.json 2023-01-01(5ef0718) 2022-09-01(main)
TopLevelDomains.json 2023-01-01(5ef0718) 2022-09-01(main)
AppServiceEnvironments.json 2023-01-01(5ef0718) 2022-09-01(main)
AppServicePlans.json 2023-01-01(5ef0718) 2022-09-01(main)
Certificates.json 2023-01-01(5ef0718) 2022-09-01(main)
CommonDefinitions.json 2023-01-01(5ef0718) 2022-09-01(main)
ContainerApps.json 2023-01-01(5ef0718) 2022-09-01(main)
ContainerAppsRevisions.json 2023-01-01(5ef0718) 2022-09-01(main)
DeletedWebApps.json 2023-01-01(5ef0718) 2022-09-01(main)
Diagnostics.json 2023-01-01(5ef0718) 2022-09-01(main)
Global.json 2023-01-01(5ef0718) 2022-09-01(main)
KubeEnvironments.json 2023-01-01(5ef0718) 2022-09-01(main)
Provider.json 2023-01-01(5ef0718) 2022-09-01(main)
Recommendations.json 2023-01-01(5ef0718) 2022-09-01(main)
ResourceHealthMetadata.json 2023-01-01(5ef0718) 2022-09-01(main)
ResourceProvider.json 2023-01-01(5ef0718) 2022-09-01(main)
StaticSites.json 2023-01-01(5ef0718) 2022-09-01(main)
WebApps.json 2023-01-01(5ef0718) 2022-09-01(main)
️️✔️CredScan succeeded [Detail] [Expand]
There is no credential detected.
️🔄LintDiff inProgress [Detail]
️️✔️Avocado succeeded [Detail] [Expand]
Validation passes for Avocado.
️❌SwaggerAPIView: 0 Errors, 0 Warnings failed [Detail]
️️✔️TypeSpecAPIView succeeded [Detail] [Expand]
️️✔️ModelValidation succeeded [Detail] [Expand]
Validation passes for ModelValidation.
️️✔️SemanticValidation succeeded [Detail] [Expand]
Validation passes for SemanticValidation.
️️✔️PoliCheck succeeded [Detail] [Expand]
Validation passed for PoliCheck.
️️✔️PrettierCheck succeeded [Detail] [Expand]
Validation passes for PrettierCheck.
️️✔️SpellCheck succeeded [Detail] [Expand]
Validation passes for SpellCheck.
️️✔️Lint(RPaaS) succeeded [Detail] [Expand]
Validation passes for Lint(RPaaS).
️️✔️PR Summary succeeded [Detail] [Expand]
Validation passes for Summary.
️️✔️Automated merging requirements met succeeded [Detail] [Expand]
Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Nov 2, 2023

Swagger Generation Artifacts

️️✔️ApiDocPreview succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️❌SDK Breaking Change Tracking failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️❌ azure-sdk-for-net-track2 failed [Detail]

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-sdk-for-python-track2 warning [Detail]

Only 0 items are rendered, please refer to log for more details.

️⚠️ azure-sdk-for-java warning [Detail]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-sdk-for-go succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️️✔️ azure-sdk-for-js succeeded [Detail] [Expand]

Only 0 items are rendered, please refer to log for more details.

️🔄 azure-resource-manager-schemas inProgress [Detail]
️❌ azure-powershell failed [Detail]

Only 0 items are rendered, please refer to log for more details.

Posted by Swagger Pipeline | How to fix these errors?

Copy link

openapi-pipeline-app bot commented Nov 2, 2023

Generated ApiView

Language Package Name ApiView Link
Go sdk/resourcemanager/appservice/armappservice https://apiview.dev/Assemblies/Review/a1034e265b934ce5bc51eb1f49bc7117
Java azure-resourcemanager-appservice-generated https://apiview.dev/Assemblies/Review/397e34a961794bb19604642bce3240b1
JavaScript @azure/arm-appservice https://apiview.dev/Assemblies/Review/d38a65a0d80a40b5822a894409a0e651

@naveedaz
Copy link
Contributor Author

naveedaz commented Nov 2, 2023

@weidongxu-microsoft Can we please merge this service branch into main once the validations pass?

Copy link

Hi @naveedaz! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version.
For more details refer to the wiki.

@kamperiadis kamperiadis removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Nov 8, 2023
@openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 8, 2023
@kamperiadis
Copy link
Contributor

kamperiadis commented Nov 8, 2023

@rkmanda @weidongxu-microsoft Can you please review this PR again? The validation failure has been resolved. Thank you!

@zizw123
Copy link

zizw123 commented Nov 8, 2023

Hi @naveedaz! For review efficiency consideration, when creating a new API version, it is required to place API specs of the base version in the first commit, and push new version updates into successive commits. You can use OpenAPIHub to initialize the PR for adding a new version. For more details refer to the wiki.

It looks like not all commits have been reviewed by ARM, some of them are missing ARMSigned off, if you can follow this guide and add base version, we can do a quick pass on the diff for this new API version.

@zizw123 zizw123 added the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Nov 8, 2023
@openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 8, 2023
@zizw123 zizw123 removed the ARMChangesRequested <valid label in PR review process>add this label when require changes after ARM review label Nov 9, 2023
@openapi-workflow-bot openapi-workflow-bot bot added the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 9, 2023
"description": "Zone redundant deployment enabled.",
"type": "boolean",
"readOnly": true
},
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

non-blocking, consider use enum over boolean for easier expansion if needed in future

@zizw123 zizw123 added the ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review label Nov 9, 2023
@openapi-workflow-bot openapi-workflow-bot bot removed the WaitForARMFeedback <valid label in PR review process> add this label when ARM review is required label Nov 9, 2023
@Alancere Alancere added the Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go label Nov 10, 2023
@kamperiadis
Copy link
Contributor

/pr RequestMerge

@naveedaz
Copy link
Contributor Author

/pr RequestMerge

@naveedaz naveedaz merged commit 69f5096 into main Nov 10, 2023
26 of 31 checks passed
@naveedaz naveedaz deleted the release-web-2023-01-01 branch November 10, 2023 09:42
Copy link

Swagger pipeline restarted successfully, please wait for status update in this comment.

zman-ms pushed a commit that referenced this pull request Jan 10, 2024
* Add new api-version 2023-01-01 (#22962)

* Add new api-version 2023-01-01

* Change default package api-version

* Updated workflowstate to be a reference (#23084)

* Fix OneDeploy request and response bodies (#23224)

* Fix OneDeploy request and response bodies

* Fixing typo

* Add Container Apps Environment Id in checknameavailability API (#24102)

Co-authored-by: Vishal Gupta <[email protected]>

* Add minTlsCipherSuite property (#24198)

* Add minTlsCipherSuite property

* Move to SiteConfig

---------

Co-authored-by: Chris Rosenblatt <[email protected]>

* Dapr configuration for a site (#24606)

* Dapr configuration for a site

* removed dapr older definition

* adding back old dapr definition

* Modified 'Dapr' to 'DaprConfig' to resolve conflicts with older dapr definition

* to initiate checks as re-run

* fixed prettier check fail

---------

Co-authored-by: Sushmitha Vangala <[email protected]>

* Fix for JS SDK check failure for Dapr Config (#25493)

* Dapr configuration for a site

* removed dapr older definition

* adding back old dapr definition

* Modified 'Dapr' to 'DaprConfig' to resolve conflicts with older dapr definition

* to initiate checks as re-run

* fixed prettier check fail

* JS Sdk check fail fix

---------

Co-authored-by: Sushmitha Vangala <[email protected]>

* Release web 2023 01 01 (#25157)

* Adding locations/usages endpoint and example

* Revert "Adding locations/usages endpoint and example"

This reverts commit 4a11107.

* Adding back usages changes with up to date branch

* Updates based on verification tools

* Fixing spacing, adding missing comma

* ran prettier-fix for formatting

* Update for new QMS requirements with ZR

* Using prettier to fix linter error

* Adding ZR endpoint

* Fixing duplicate operationId

* QMS Usages

* Validation changes

* Updating schema

* Updating for collection

* fixing pr comments

* Resolving comments

* Updating description

* Resolving comments

---------

Co-authored-by: Rohini Sharma <[email protected]>

* Release web 2023 01 01 (#25629)

* Adding locations/usages endpoint and example

* Revert "Adding locations/usages endpoint and example"

This reverts commit 4a11107.

* Adding back usages changes with up to date branch

* Updates based on verification tools

* Fixing spacing, adding missing comma

* ran prettier-fix for formatting

* Update for new QMS requirements with ZR

* Using prettier to fix linter error

* Adding ZR endpoint

* Fixing duplicate operationId

* QMS Usages

* Validation changes

* Updating schema

* Updating for collection

* fixing pr comments

* Resolving comments

* Updating description

* Resolving comments

* Removing quota type parameter

---------

Co-authored-by: Rohini Sharma <[email protected]>

* Adding workload profile & resource config to Site (#25868)

* Adding workload profile & resource config to Site

* prettier fix

* cosmetic fix

* updating examples

* prettier fix

* Fix Python SDK failure for Dapr log level config (#26198)

* Rename log level enum for dapr

* Fix Python SDK failure for Dapr log level config

* Rename log level num for dapr (#26374)

* Rename log level num for dapr

* Rename log level num for dapr

* initial change to add ase regions (#26333)

* initial change to add ase regions

* addressing comments

* nit adding example as suggested

* formatting code

* add custom word

* prettier everything

* prettier everything

* Revert "Fix OneDeploy request and response bodies (#23224)" (#26580)

This reverts commit 7dfc303.

---------

Co-authored-by: Alex Karcher <[email protected]>
Co-authored-by: dannysongg <[email protected]>
Co-authored-by: Vishal Gupta <[email protected]>
Co-authored-by: Vishal Gupta <[email protected]>
Co-authored-by: Chris Rosenblatt <[email protected]>
Co-authored-by: Chris Rosenblatt <[email protected]>
Co-authored-by: SushmithaVReddy <[email protected]>
Co-authored-by: Sushmitha Vangala <[email protected]>
Co-authored-by: rohinisharma <[email protected]>
Co-authored-by: Rohini Sharma <[email protected]>
Co-authored-by: mukundnigam <[email protected]>
Co-authored-by: Kirstyn Amperiadis <[email protected]>
Co-authored-by: Haochi <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Approved-SdkBreakingChange-Go Approve the breaking change tracking for azure-sdk-for-go Approved-SdkBreakingChange-JavaScript ARMReview ARMSignedOff <valid label in PR review process>add this label when ARM approve updates after review CI-BreakingChange-Go CI-BreakingChange-JavaScript CI-MissingBaseCommit new-api-version ReadyForApiTest <valid label in PR review process>add this label when swagger and service APIs are ready for test resource-manager
Projects
None yet
Development

Successfully merging this pull request may close these issues.